<?php
/**
 * Zend Framework
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file LICENSE.txt.
 * It is also available through the world-wide-web at this URL:
 * http://framework.zend.com/license/new-bsd
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@zend.com so we can send you a copy immediately.
 *
 * @category   Zend
 * @package    Zend_Captcha
 * @subpackage Adapter
 * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */

/** Zend_Captcha_Base */
require_once 'Zend/Captcha/Base.php';

/** Zend_Service_ReCaptcha */
require_once 'Zend/Service/ReCaptcha.php';

/**
 * ReCaptcha adapter
 *
 * Allows to insert captchas driven by ReCaptcha service
 *
 * @see http://recaptcha.net/apidocs/captcha/
 *
 * @category   Zend
 * @package    Zend_Captcha
 * @subpackage Adapter
 * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 * @version    $Id: ReCaptcha.php 18166 2009-09-17 13:28:35Z padraic $
 */
class Zend_Captcha_ReCaptcha extends Zend_Captcha_Base
{
	/**@+
	 * ReCaptcha Field names
	 * @var string
	 */
	protected $_CHALLENGE = 'recaptcha_challenge_field';
	protected $_RESPONSE  = 'recaptcha_response_field';
	/**@-*/

	/**
	 * Recaptcha service object
	 *
	 * @var Zend_Service_Recaptcha
	 */
	protected $_service;

	/**
	 * Parameters defined by the service
	 *
	 * @var array
	 */
	protected $_serviceParams = array();

	/**
	 * Options defined by the service
	 *
	 * @var array
	 */
	protected $_serviceOptions = array();

	/**#@+
	 * Error codes
	 * @const string
	 */
	const MISSING_VALUE = 'missingValue';
	const ERR_CAPTCHA   = 'errCaptcha';
	const BAD_CAPTCHA   = 'badCaptcha';
	/**#@-*/

	/**
	 * Error messages
	 * @var array
	 */
	protected $_messageTemplates = array(
	self::MISSING_VALUE => 'Missing captcha fields',
	self::ERR_CAPTCHA   => 'Failed to validate captcha',
	self::BAD_CAPTCHA   => 'Captcha value is wrong: %value%',
	);

	/**
	 * Retrieve ReCaptcha Private key
	 *
	 * @return string
	 */
	public function getPrivkey()
	{
		return $this->getService()->getPrivateKey();
	}

	/**
	 * Retrieve ReCaptcha Public key
	 *
	 * @return string
	 */
	public function getPubkey()
	{
		return $this->getService()->getPublicKey();
	}

	/**
	 * Set ReCaptcha Private key
	 *
	 * @param string $privkey
	 * @return Zend_Captcha_ReCaptcha
	 */
	public function setPrivkey($privkey)
	{
		$this->getService()->setPrivateKey($privkey);
		return $this;
	}

	/**
	 * Set ReCaptcha public key
	 *
	 * @param string $pubkey
	 * @return Zend_Captcha_ReCaptcha
	 */
	public function setPubkey($pubkey)
	{
		$this->getService()->setPublicKey($pubkey);
		return $this;
	}

	/**
	 * Constructor
	 *
	 * @param  array|Zend_Config $options
	 * @return void
	 */
	public function __construct($options = null)
	{
		$this->setService(new Zend_Service_ReCaptcha());
		$this->_serviceParams = $this->getService()->getParams();
		$this->_serviceOptions = $this->getService()->getOptions();

		parent::__construct($options);

		if ($options instanceof Zend_Config) {
			$options = $options->toArray();
		}
		if (!empty($options)) {
			$this->setOptions($options);
		}
	}

	/**
	 * Set service object
	 *
	 * @param  Zend_Service_ReCaptcha $service
	 * @return Zend_Captcha_ReCaptcha
	 */
	public function setService(Zend_Service_ReCaptcha $service)
	{
		$this->_service = $service;
		return $this;
	}

	/**
	 * Retrieve ReCaptcha service object
	 *
	 * @return Zend_Service_ReCaptcha
	 */
	public function getService()
	{
		return $this->_service;
	}

	/**
	 * Set option
	 *
	 * If option is a service parameter, proxies to the service. The same
	 * goes for any service options (distinct from service params)
	 *
	 * @param  string $key
	 * @param  mixed $value
	 * @return Zend_Captcha_ReCaptcha
	 */
	public function setOption($key, $value)
	{
		$service = $this->getService();
		if (isset($this->_serviceParams[$key])) {
			$service->setParam($key, $value);
			return $this;
		}
		if (isset($this->_serviceOptions[$key])) {
			$service->setOption($key, $value);
			return $this;
		}
		return parent::setOption($key, $value);
	}

	/**
	 * Generate captcha
	 *
	 * @see Zend_Form_Captcha_Adapter::generate()
	 * @return string
	 */
	public function generate()
	{
		return "";
	}

	/**
	 * Validate captcha
	 *
	 * @see    Zend_Validate_Interface::isValid()
	 * @param  mixed $value
	 * @return boolean
	 */
	public function isValid($value, $context = null)
	{
		if (!is_array($value) && !is_array($context)) {
			$this->_error(self::MISSING_VALUE);
			return false;
		}

		if (!is_array($value) && is_array($context)) {
			$value = $context;
		}

		if (empty($value[$this->_CHALLENGE]) || empty($value[$this->_RESPONSE])) {
			$this->_error(self::MISSING_VALUE);
			return false;
		}

		$service = $this->getService();

		$res = $service->verify($value[$this->_CHALLENGE], $value[$this->_RESPONSE]);

		if (!$res) {
			$this->_error(self::ERR_CAPTCHA);
			return false;
		}

		if (!$res->isValid()) {
			$this->_error(self::BAD_CAPTCHA, $res->getErrorCode());
			$service->setParam('error', $res->getErrorCode());
			return false;
		}

		return true;
	}

	/**
	 * Render captcha
	 *
	 * @param  Zend_View_Interface $view
	 * @param  mixed $element
	 * @return string
	 */
	public function render(Zend_View_Interface $view = null, $element = null)
	{
		return $this->getService()->getHTML();
	}
}
